Rainbow Android SDK/com.ale.infra.rest.user/InviteUser

InviteUser

@Serializable
class InviteUser

Represents the parameters required to invite a user via email, phone number, or user ID in the Rainbow platform. This class is used to construct customized invitations, such as specifying the language or adding a custom message.

Instances of InviteUser should be created using the Builder class.

Types

Link copied to clipboard
data class Builder(    email: String? = null,     invitedPhoneNumber: String? = null,     invitedUserId: String? = null,     lang: String? = null,     customMessage: String? = null)

Builder class for constructing InviteUser instances.

Properties

Link copied to clipboard
val customMessage: String? = null

A custom message to include in the invitation. The maximum length is 100,000 characters. Optional.

Link copied to clipboard
val email: String? = null

The email address of the user to invite. Must be between 3 and 255 characters. Optional.

Link copied to clipboard
val invitedPhoneNumber: String? = null

The phone number of the user to invite. Optional.

Link copied to clipboard
val invitedUserId: String? = null

The Rainbow user ID of the user to invite. Optional.

Link copied to clipboard
val lang: String? = null

The preferred language of the invitation. Should be an ISO 639-1 code (e.g., "en", "fr"). Optional.